<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
	<title>YUI Library Examples: Rich Text Editor: Editor in a Dialog Control</title>
    

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
    	<link rel="stylesheet" type="text/css" href="../../assets/yui.css" >

<style>
/*Supplemental CSS for the YUI distribution*/
#custom-doc { width: 95%; min-width: 950px; }
#pagetitle {background-image: url(../../assets/bg_hd.gif);}
</style>

<link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css">
<!--Script and CSS includes for YUI dependencies on this page-->
<link rel="stylesheet" type="text/css" href="../../build/menu/assets/skins/sam/menu.css" />
<link rel="stylesheet" type="text/css" href="../../build/button/assets/skins/sam/button.css" />
<link rel="stylesheet" type="text/css" href="../../build/container/assets/skins/sam/container.css" />
<link rel="stylesheet" type="text/css" href="../../build/editor/assets/skins/sam/editor.css" />
<script type="text/javascript" src="../../build/yuiloader/yuiloader-min.js"></script>
<script type="text/javascript" src="../../build/json/json-min.js"></script>
<script type="text/javascript" src="../../build/event/event-min.js"></script>
<script type="text/javascript" src="../../build/dom/dom-min.js"></script>
<script type="text/javascript" src="../../build/element/element-min.js"></script>
<script type="text/javascript" src="../../build/button/button-min.js"></script>
<script type="text/javascript" src="../../build/container/container-min.js"></script>
<script type="text/javascript" src="../../build/connection/connection-min.js"></script>
<script type="text/javascript" src="../../build/menu/menu-min.js"></script>
<script type="text/javascript" src="../../build/editor/editor-min.js"></script>


<!--begin custom header content for this example-->
<style type="text/css">
  	#responseContainer {	
		margin:1em;
	  	border: 1px solid black;
	    background-color: #ccc;
	    height: 4em;
		padding: 1em;
	}
</style>
<!--end custom header content for this example-->


<script type="text/javascript">
//enable passthrough of errors from YUI Event:
if ((typeof YAHOO !== "undefined") && (YAHOO.util) && (YAHOO.util.Event)) {
	YAHOO.util.Event.throwErrors = true;
}
</script>
</head>
<body id="yahoo-com" class="yui-skin-sam">
<div id="custom-doc" class="yui-t2">
<div id="hd">
	<div id="ygunav">
		<p><em><a href="http://developer.yahoo.com/yui/">YUI Library Home</a></em></p>
		<form action="http://search.yahoo.com/search" id="sitesearchform">
		<input name="vs" type="hidden" value="developer.yahoo.com">
		<input name="vs" type="hidden" value="yuiblog.com">
		<div id="sitesearch">
			<label for="searchinput">Site Search (YDN &amp; YUIBlog): </label>
			<input type="text" id="searchinput" name="p">
			<input type="submit" value="Search" id="searchsubmit" class="ygbt">
		</div>
		</form>	</div>
	<div id="ygma"><a href="../../"><img src="../../assets/yui.gif"  border="0" height="38"></a></div>
	<div id="pagetitle"><h1>YUI Library Examples: Rich Text Editor: Editor in a Dialog Control</h1></div>
</div>
<div id="bd">
	
	<div id="yui-main">
		<div class="yui-b">
		  <div class="yui-ge">
			  <div class="yui-u first example">

    
	<div class="promo">
	<h1>Rich Text Editor: Editor in a Dialog Control</h1>
	
	<div class="exampleIntro">
	<p>In YUI-based applications, it's common for forms to appear as part of <a href="http://developer.yahoo.com/yui/container/dialog/">Dialogs</a>.  In this example, a form enhanced with the <a href="http://developer.yahoo.com/yui/editor">Rich Text Editor</a> appears in a Dialog.  Read the tutorial below to learn how to integrate the RTE seamlessly with your Dialog's form contents.</p>
	
			
	</div>	
					
	<div class="example-container module ">
			<div class="hd exampleHd">
			<p class="newWindowButton yui-skin-sam"><!--<span id="newWindowLinkx"><span class="first-child">--><a href="dialog_editor_clean.html" target="_blank">View example in new window.</a><!--</span></span>-->		
		</div>		<div id="example-canvas" class="bd">
	
		
	<!--BEGIN SOURCE CODE FOR EXAMPLE =============================== -->
	
	<div id="dialogContainer">
	<div class="hd">Enter Title and Description:</div>
	<div class="bd">
		<form id="dialogForm" name="dialogForm" method="post" action="../editor/assets/post.php">
			
			<p><label for="title">Title:</label> <input name="title" id="title" /></p>
			
			<p><label for="description">Description:</label></p>
			
				<textarea name="description" id="description"></textarea>
			
			<div id="descriptionContainer"></div>
			
			<!--This element is here only for purposes of Progressive Enhancement; we will disable and
			hide it as we render the Dialog so that doesn't interfere with the Dialog's operation.-->
			<p><input id="submitButton" type="submit" /></p>
			
		</form>
	</div>
</div>

<button id="showDlg">Show Dialog</button>

<div id="responseContainer">
	<p>Dialog's post response will appear here after you submit the Dialog.</p>
</div>

<script language="JavaScript">
(function() {

	//hide and disable the non-dialog submit button:
	document.getElementById("submitButton").disabled = true;
	document.getElementById("submitButton").style.display = "none";
	
	//create the RTE:
	var editor = new YAHOO.widget.Editor('description', {
	    width: '702px',
		height: '200px'
	});

    //After the Editor renders it, we will hide it
    //so the iframe doesn't bleed through
	editor.on('afterRender', editor.hide);

	//render the editor explicitly into a container
	//within the Dialog's DOM:
	editor.render();
	
	//create Dialog:
	var dlg = new YAHOO.widget.Dialog("dialogContainer", {
		width:"725px",
		fixedcenter:true,
		modal:true,
		visible:false
	});

	//event handlers for our Dialog buttons:
	
	//if the user clicks "save", then we save the HTML
	//content of the RTE and submit the dialog:
	function handleSave() {
		editor.saveHTML();
		this.submit();
	}
	
	//if the user clicks cancel, we call Dialog's
	//cancel method:
	function handleCancel() {
		this.cancel();
	}
	
	//set up buttons for the Dialog and wire them
	//up to our handlers:
	var myButtons = [ { text:"Save", 
						handler:handleSave },
					  { text:"Cancel", 
						handler:handleCancel,
						isDefault:true } ];
	dlg.cfg.queueProperty("buttons", myButtons);

	//Dialog by default will use Connection Manager to POST
	//form contents to the URI specified in the action
	//attribute of the form; we can wire up success and
	//failure handlers for the XHR call and act on them
	//just as we would with any Connection Manager
	//transaction:
	var onSuccess = function(o) {
		//we're going to get JSON back from post.php; we
		//can parse it using JSON.parse:
		var data = YAHOO.lang.JSON.parse(o.responseText);
		
		//in this case, we'll just output the contents to 
		//a div to see what they contain:
        document.getElementById("responseContainer").innerHTML = 'Status: ' + 
			data.Results.status + 
			'<br>' + (new Date().toString());
	}
	var onFailure = function(o) {
		//in the event of a failure, we can log the problem:
		YAHOO.log("Dialog reported a communication failure; connection object: " + YAHOO.lang.dump(o, 5));
	}
	dlg.callback.success = onSuccess;
	dlg.callback.failure = onFailure;

	//Now that our Dialog is fully configured, we can
	//render it:
	dlg.render();
	
	//RTE needs a little love to work in in a Dialog that can be 
	//shown and hidden; we let it know that it's being
	//shown/hidden so that it can recover from these actions:
	dlg.showEvent.subscribe(editor.show, editor, true);
	dlg.hideEvent.subscribe(editor.hide, editor, true);
	
	//instantiate button to show Dialog:
	var btn = new YAHOO.widget.Button("showDlg", {type:"link"});
	btn.on("click", dlg.show, dlg, true);
	
})();
</script>
	
	<!--END SOURCE CODE FOR EXAMPLE =============================== -->
	
		
		</div>
		
	
	</div>			
	</div>
		
	<h2 class="first">Using Rich Text Editor in a Dialog Control</h2>

<p>When using a Rich Text Editor in a <a href="http://developer.yahoo.com/yui/container/dialog">Dialog Control</a>, there are a few considerations:</p>

<ul>
	<li>The editor and the elements it creates (particularly the floating properties palettes) need to be rendered into the Dialog's DOM structure.  If the Dialog is modal, it will try to maintain focus within its DOM confines, so ensuring that all editor elements are children of the Dialog's DOM is crucial.</li>
	<li>The most common way to submit a Dialog's form contents is asynchronously using <a href="http://developer.yahoo.com/yui/connection/">Connection Manager</a>.  This means that editor cannot automatically attach itself to the form's <code>submit</code> event.  Instead, we need to call the editor's <code>saveHTML</code> method prior to executing the Dialog's <code>submit</code> method.</li>
	<li>The Rich Text Editor needs special handling when it is hidden (ie, when a parent element is set to <code>display:none</code>).  Dialogs, of course, are usually hidden by default and appear only in response to user action.  As a result, we need to listen for the Dialog's <code>showEvent</code> and <code>hideEvent</code> and prepare the Rich Text Editor to recover gracefully when the Dialog is hidden from view.</li>
</ul>

<p>These three considerations are each accounted for in the code below, which is fully commented and represents the full JavaScript source for this implementation:</p>

<textarea name="code" class="JScript">
(function() {

	//hide and disable the non-dialog submit button:
	document.getElementById("submitButton").disabled = true;
	document.getElementById("submitButton").style.display = "none";
	
	//create the RTE:
	var editor = new YAHOO.widget.Editor('description', {
	    width: '702px',
		height: '200px'
	});

    //After the Editor renders it, we will hide it
    //so the iframe doesn't bleed through
	editor.on('afterRender', editor.hide);

	//render the editor explicitly into a container
	//within the Dialog's DOM:
	editor.render();
	
	//create Dialog:
	var dlg = new YAHOO.widget.Dialog("dialogContainer", {
		width:"725px",
		fixedcenter:true,
		modal:true,
		visible:false
	});

	//event handlers for our Dialog buttons:
	
	//if the user clicks "save", then we save the HTML
	//content of the RTE and submit the dialog:
	function handleSave() {
		editor.saveHTML();
		this.submit();
	}
	
	//if the user clicks cancel, we call Dialog's
	//cancel method:
	function handleCancel() {
		this.cancel();
	}
	
	//set up buttons for the Dialog and wire them
	//up to our handlers:
	var myButtons = [ { text:"Save", 
						handler:handleSave },
					  { text:"Cancel", 
						handler:handleCancel,
						isDefault:true } ];
	dlg.cfg.queueProperty("buttons", myButtons);

	//Dialog by default will use Connection Manager to POST
	//form contents to the URI specified in the action
	//attribute of the form; we can wire up success and
	//failure handlers for the XHR call and act on them
	//just as we would with any Connection Manager
	//transaction:
	var onSuccess = function(o) {
		//we're going to get JSON back from post.php; we
		//can parse it using JSON.parse:
		var data = YAHOO.lang.JSON.parse(o.responseText);
		
		//in this case, we'll just output the contents to 
		//a div to see what they contain:
        document.getElementById("container").innerHTML = 'Status: ' + 
			data.Results.status + 
			'<br>' + (new Date().toString());
	}
	var onFailure = function(o) {
		//in the event of a failure, we can log the problem:
		YAHOO.log("Dialog reported a communication failure; connection object: " + YAHOO.lang.dump(o, 5));
	}
	dlg.callback.success = onSuccess;
	dlg.callback.failure = onFailure;
	
	//Now that our Dialog is fully configured, we can
	//render it:
	dlg.render();
	
	//RTE needs a little love to work in in a Dialog that can be 
	//shown and hidden; we let it know that it's being
	//shown/hidden so that it can recover from these actions:
	dlg.showEvent.subscribe(editor.show, editor, true);
	dlg.hideEvent.subscribe(editor.hide, editor, true);
	
	//instantiate button to show Dialog:
	var btn = new YAHOO.widget.Button("showDlg", {type:"link"});
	btn.on("click", dlg.show, dlg, true);
	
})();
</textarea>

<h2>Configuration for This Example</h2>

<p>You can load the necessary JavaScript and CSS for this example from Yahoo's servers.  <a href="http://developer.yahoo.com/yui/articles/hosting/?json&event&dom&element&button&container&connection&editor&MIN#configure">Click here to load the YUI Dependency Configurator with all of this example's dependencies preconfigured</a>.</p>

				</div>
				<div class="yui-u">
						<div id="loggerModule" class="yui-skin-sam">
						<h3 class="firstContent">YUI Logger Output:</h3>
								<div id="loggerGloss"><p><strong>Note:</strong> Logging and debugging is currently turned off for this example.</p> 
							<p class="loggerButton"><span id="loggerLink"><span class="first-child"><a href="dialog_editor_log.html">Reload with logging<br />
	 and debugging enabled.</a></span></span></p></div>
	
						</div>
					
				
					<div id="examples">
						<h3>Rich Text Editor Examples:</h3>
	
						<div id="exampleToc">
							<ul>
								<li><a href='../editor/flickr_editor.html'>Flickr Image Search</a></li><li><a href='../editor/cal_editor.html'>Calendar Plugin</a></li><li><a href='../editor/icon_editor.html'>Icon Insertion</a></li><li><a href='../editor/switch_editor.html'>Plain Text Switcher</a></li><li><a href='../editor/post_editor.html'>Editor Data Post with Connection Manager</a></li><li><a href='../editor/skinning_editor.html'>Skinning the Editor</a></li><li><a href='../editor/toolbar_editor.html'>Default Toolbar Config</a></li><li><a href='../editor/code_editor.html'>Code Editor</a></li><li><a href='../editor/tabview_editor.html'>Editor inside a Tabview Control</a></li><li><a href='../editor/multi_editor.html'>One Editor, Multiple Edit Areas</a></li><li><a href='../editor/imagebrowser_editor.html'>Editor with Custom Image Browser</a></li><li><a href='../editor/simple_editor.html'>Simple Editor &mdash; Basic Buttons</a></li><li><a href='../editor/simple_adv_editor.html'>Simple Editor &mdash; Advanced Buttons</a></li><li><a href='../editor/editor_adv_editor.html'>Editor &mdash; Basic Buttons</a></li><li><a href='../editor/autoheight_editor.html'>Editor Auto Adjusting Height</a></li><li class='selected'><a href='../editor/dialog_editor.html'>Editor in a Dialog Control</a></li><li><a href='../resize/rte_resize.html'>Custom resizing for the Rich Text Editor (included with examples for Resize Utility)</a></li><li><a href='../layout/calrte_layout.html'>Simple Application (included with examples for Layout Manager)</a></li><li><a href='../layout/adv_layout.html'>Complex Application (included with examples for Layout Manager)</a></li>							</ul>
						</div>
					</div>
					
					<div id="module">
						<h3>More Rich Text Editor Resources:</h3>
						<ul>
							<li><a href="http://developer.yahoo.com/yui/editor/">User's Guide</a> (external)</li>
						<li><a href="../../docs/module_editor.html">API Documentation</a></li>
                            
                            
							<li><a href="http://yuiblog.com/assets/pdf/cheatsheets/editor.pdf">Cheat Sheet PDF</a> (external)</li></ul>
					</div>
			  </div>
		</div>
		
		</div>
	</div>


<div class="yui-b" id="tocWrapper">
<!-- TABLE OF CONTENTS -->
<div id="toc">
	
<ul>
<li class="sect first">Yahoo! UI Library</li><li class="item"><a title="The Yahoo! User Interface Library (YUI)" href="http://developer.yahoo.com/yui/">Home (external)</a></li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUIBlog (external)</a></li><li class="item"><a title="YUILibrary.com hosts the YUI community forums" href="http://yuilibrary.com/forum/">YUI Discussion Forum (external)</a></li><li class="item"><a title="The YUI Library source can be checked out from GitHub" href="http://github.com/yui/">YUI on GitHub</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../docs/index.html">API Documentation</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">Functional Examples</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/license.html">YUI License (external)</a></li><li class="sect">YUI Functional Examples</li><li class="item"><a title="The YUI Animation Utility - Functional Examples" href="../../examples/animation/index.html">Animation</a></li><li class="item"><a title="The YUI AutoComplete Control - Functional Examples" href="../../examples/autocomplete/index.html">AutoComplete</a></li><li class="item"><a title="The YUI Browser History Manager - Functional Examples" href="../../examples/history/index.html">Browser History Manager</a></li><li class="item"><a title="The YUI Button Control - Functional Examples" href="../../examples/button/index.html">Button</a></li><li class="item"><a title="The YUI Calendar Control - Functional Examples" href="../../examples/calendar/index.html">Calendar</a></li><li class="item"><a title="The YUI Carousel Control - Functional Examples" href="../../examples/carousel/index.html">Carousel</a></li><li class="item"><a title="The YUI Charts Control - Functional Examples" href="../../examples/charts/index.html">Charts</a></li><li class="item"><a title="The YUI Color Picker Control - Functional Examples" href="../../examples/colorpicker/index.html">Color Picker</a></li><li class="item"><a title="The YUI Cookie Utility - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="The YUI Connection Manager (AJAX) - Functional Examples" href="../../examples/connection/index.html">Connection Manager</a></li><li class="item"><a title="The YUI Container Family (Module, Overlay, Tooltip, Panel, Dialog, SimpleDialog) - Functional Examples" href="../../examples/container/index.html">Container</a></li><li class="item"><a title="The YUI DataTable Control - Functional Examples" href="../../examples/datatable/index.html">DataTable</a></li><li class="item"><a title="The YUI Dom Collection - Functional Examples" href="../../examples/dom/index.html">Dom</a></li><li class="item"><a title="The YUI Drag &amp; Drop Utility - Functional Examples" href="../../examples/dragdrop/index.html">Drag &amp; Drop</a></li><li class="item"><a title="The YUI Event Utility - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="The YUI Get Utility - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="The YUI ImageCropper Control - Functional Examples" href="../../examples/imagecropper/index.html">ImageCropper</a></li><li class="item"><a title="The YUI ImageLoader Utility - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="The YUI JSON Utility - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="The YUI Layout Manager - Functional Examples" href="../../examples/layout/index.html">Layout Manager</a></li><li class="item"><a title="The YUI Logger Control - Functional Examples" href="../../examples/logger/index.html">Logger</a></li><li class="item"><a title="The YUI Menu Control - Functional Examples" href="../../examples/menu/index.html">Menu</a></li><li class="item"><a title="The YUI Paginator - Functional Examples" href="../../examples/paginator/index.html">Paginator</a></li><li class="item"><a title="The YUI Profiler Utility - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="item"><a title="The YUI ProfileViewer Control - Functional Examples" href="../../examples/profilerviewer/index.html">ProfilerViewer</a></li><li class="item"><a title="The YUI ProgressBar Control - Functional Examples" href="../../examples/progressbar/index.html">ProgressBar</a></li><li class="item"><a title="The YUI Resize Utility - Functional Examples" href="../../examples/resize/index.html">Resize</a></li><li class="selected "><a title="The YUI Rich Text Editor - Functional Examples" href="../../examples/editor/index.html">Rich Text Editor</a></li><li class="item"><a title="The YUI Selector Utility - Functional Examples" href="../../examples/selector/index.html">Selector</a></li><li class="item"><a title="The YUI Slider Control - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="item"><a title="The YUI Storage Utility - Functional Examples" href="../../examples/storage/index.html">Storage</a></li><li class="item"><a title="The YUI SWF Utility - Functional Examples" href="../../examples/swf/index.html">SWF</a></li><li class="item"><a title="The YUI SWFStore Utility - Functional Examples" href="../../examples/swfstore/index.html">SWFStore</a></li><li class="item"><a title="The YUI Stylesheet Utility - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="item"><a title="The YUI TabView Control - Functional Examples" href="../../examples/tabview/index.html">TabView</a></li><li class="item"><a title="The YUI TreeView Control - Functional Examples" href="../../examples/treeview/index.html">TreeView</a></li><li class="item"><a title="The YUI Uploader Utility - Functional Examples" href="../../examples/uploader/index.html">Uploader (experimental)</a></li><li class="item"><a title="The YUI YAHOO Global Object - Functional Examples" href="../../examples/yahoo/index.html">YAHOO Global Object</a></li><li class="item"><a title="The YUI Loader Utility - Functional Examples" href="../../examples/yuiloader/index.html">YUI Loader</a></li><li class="item"><a title="The YUI Test Utility - Functional Examples" href="../../examples/yuitest/index.html">YUI Test</a></li><li class="item"><a title="YUI Reset CSS - Functional Examples" href="../../examples/reset/index.html">Reset CSS</a></li><li class="item"><a title="YUI Base CSS - Functional Examples" href="../../examples/base/index.html">Base CSS</a></li><li class="item"><a title="YUI Fonts CSS - Functional Examples" href="../../examples/fonts/index.html">Fonts CSS</a></li><li class="item"><a title="YUI Grids CSS - Functional Examples" href="../../examples/grids/index.html">Grids CSS</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li><li class="item"><a title="Best practices for working with web services while protecting user privacy" href="http://developer.yahoo.com/security/">Security Best Practices (external)</a></li></ul>
</div>
</div>
	</div><!--closes bd-->

	<div id="ft">
        <p class="first">Copyright &copy; 2011 Yahoo! Inc. All rights reserved.</p>
        <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - 
            <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - 
            <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - 
            <a href="http://careers.yahoo.com/">Job Openings</a></p>
	</div>
</div>
<script src="../../assets/syntax.js"></script>
<script src="../../assets/dpSyntaxHighlighter.js"></script>
<script language="javascript"> 
dp.SyntaxHighlighter.HighlightAll('code'); 
</script>

<script src='../../assets/YUIexamples.js'></script>


</body>
</html>
